home
***
CD-ROM
|
disk
|
FTP
|
other
***
search
/
EnigmA Amiga Run 1995 October
/
EnigmA AMIGA RUN 01 (1995)(G.R. Edizioni)(IT)[!][issue 1995-10][Aminet 7].iso
/
Aminet
/
dev
/
gui
/
BGUI11c.lha
/
docs
/
vectorclass.doc
< prev
next >
Wrap
Text File
|
1995-04-23
|
6KB
|
165 lines
File: vectorclass.doc
Description: Vectorclass documentation.
Copyright: (C) Copyright 1994-1995 Jaba Development.
(C) Copyright 1994-1995 Jan van den Baard.
All Rights Reserved.
------------------------------------------------------------------------------
TABLE OF CONTENTS
vectorclass/--background--
vectorclass/Methods
vectorclass/Attributes
vectorclass/--background-- vectorclass/--background--
NAME
Class: vectorclass
Superclass: IMAGECLASS
Include File: <libraries/bgui.h>
FUNCTION
To provide you with an easy way to create simple, fully scalable
images. The image consists of an array of small structures which
contains coordinates and command flags.
vectorclass/Methods vectorclass/Methods
NEW METHODS
None.
CHANGED METHODS
None.
vectorclass/Attributes vectorclass/Attributes
NAME
VIT_VectorArray -- ( struct VectorItem * )
FUNCTION
Set or get a pointer to an array of VectorItem structure. The
VectorItem structure is a small structure which contains information
on the coordinates and command flags.
struct VectorItem {
WORD vi_x;
WORD vi_y;
ULONG vi_Flags;
};
vi_x -- This field contains either the x-coordinate of the next point
or other data depending which command flags are set in the
vi_Flags field.
vi_y -- This field contains either the y-coordinate of the next point
or other data depending which command flags are set in the
vi_Flags field.
vi_Flags -- This field can contain any of the following flags:
VIF_MOVE -- Move to the location described in vi_x and vi_y.
VIF_DRAW -- Draw to the location described in vi_x and vi_y.
VIF AREASTART -- Start area-filling at the location described
in vi_x, vi_y. All VIF_MOVE and VIF_DRAW commands
will now AreaMove() and AreaDraw().
VIF_AREAEND -- End area-filling at the location described in
vi_x, vi_y. All VIF_MOVE and VIF_DRAW commands will
now Move() and Draw().
VIF_XRELRIGHT -- vi_x is releative to the right image border.
VIF_YRELBOTTOM -- vi_y is releative to the bottom image
border.
VIF_SHADOWPEN -- Set the SHADOWPEN and move/draw.
VIF_SHINEPEN -- Set the SHINEPEN and move/draw.
VIF_FILLPEN -- Set the FILLPEN and move/draw.
VIF_TEXTPEN -- Set the TEXTPEN and move/draw.
VIF_COLOR -- Set the pen described in vi_x. No move/draw.
VIF_LASTITEM -- This flag terminates the VectorItem array.
This flag _must_ be set in the last VectorItem of the
array as it's the only way for the class to know when
it has reached the end.
VIF_SCALE -- vi_x and vi_y contain the design size of the
image. The design size usually is the size of the
image when using a 8x8 font. Without this information
the image cannot and will not scale.
VIF_DRIPEN -- Set the drawinfo pen described in vi_x. No move/
draw. See <intuition/screens.h> about drawinfo pens.
VIF_AOLPEN -- Set the area-outline pen to the pen described in
vi_x. No move/draw.
VIF_AOLDRIPEN -- Set the area-ouline pen to the drawinfo pen
described in vi_x. No move/draw. See <intuition/
screens.h> about drawinfo pens.
VIF_ENDOPEN -- Terminate the area-outline mode.
Default is NULL. Applicability is (ISG).
NAME
VIT_BuiltIn -- ( ULONG )
FUNCTION
Set or get any of the built-in images. You can select any of the
following images:
BUILTIN_GETPATH -- Also know as a folder image. This image is usually
used in a button which pops up a filerequester to select a
drawer.
BUILTIN_GETFILE -- This imahe is usually used in a button which pops
up a filerequester to select a file.
BUILTIN_CHECKMARK -- Standard, fully scalable, checkmark/checkbox
image.
BUILTIN_POPUP -- This image is usually used in a button which pops up
a requester to select some sort of data like screen mode,
fonts etc.
BUILTIN_ARROW_UP -- A up arrow image.
BUILTIN_ARROW_DOWN -- A down arrao image.
BUILTIN_ARROW_LEFT -- A left arrow image.
BUILTIN_ARROW_RIGHT -- A right arrow image.
Default is 0 (none). Applicability is (ISG).
NAME
VIT_Pen -- ( UWORD )
FUNCTION
Set or get the pen which is used to render the image.
Default is ~0. Applicability is (ISG).
SEE ALSO
VIT_DriPen
NAME
VIT_DriPen -- ( UWORD )
FUNCTION
Set or get the drawinfo pen used to render the image.
Default is ~0. Applicability is (ISG).
SEE ALSO
<intuition/screens.h>, VIT_Pen